/*$$
 * Copyright (c) 1999, Trustees of the University of Chicago
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with 
 * or without modification, are permitted provided that the following 
 * conditions are met:
 *
 *	 Redistributions of source code must retain the above copyright notice,
 *	 this list of conditions and the following disclaimer.
 *
 *	 Redistributions in binary form must reproduce the above copyright notice,
 *	 this list of conditions and the following disclaimer in the documentation
 *	 and/or other materials provided with the distribution.
 *
 * Neither the name of the University of Chicago nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE TRUSTEES OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *$$*/
package uchicago.src.sim.engine;

public class AddIncrementer implements Incrementer {

  private double curVal;
  private double start;
  private double end;
  private double incr;

  public AddIncrementer(double start, double end, double incr) {
    this.start = start;
    this.end = end;
    this.incr = incr;

    curVal = start;
  }

  public boolean increment() {
    boolean retVal = true;
    curVal += incr;
    if (curVal > end) {
      retVal = false;
      curVal = start;
    }

    return retVal;
  }

  public String getStringValue() {
    return String.valueOf(curVal);
  }

  public boolean isConstant() {
    return incr == 0;
  }

  /**
   * Returns the value of this incrementer in parameter file format. For
   * example, set: 1.2.
   */
  public String getValAsParameterSet() {
    return "set: " + String.valueOf(curVal);
  }

/**
 * @return
 * @see uchicago.src.sim.engine.Incrementer#getValue()
 */
public Object getValue() {
    return new Double(curVal);
}

}
